Skip to main content
Feedback

Get Golden Record

The Get Golden Record operation retrieves the entity corresponding to a specified golden record in a specified universe (domain) under the authenticated account.

Basic authentication

To perform this operation, send an HTTP GET request to:

https://<base URL>/mdm/universes/universeID/records/<recordID>

where base URL is the URL for your Hub cloud that hosts your repository.

JWT authentication

To perform this operation using JSON Web Token (JWT) auth, send an HTTP GET request to:

https://<base URL>/mdm/universes/universeID/records/<recordID>?repositoryId=<repository ID>

You must have the following MDM privileges:

  • With the Advanced Security feature on your account:

    • MDM - Stewardship with the View Records Hub role entitlement for the queried repository
      or
    • MDM - Stewardship Management

  • Without Advanced Security:

    • MDM - Stewardship
      or
    • MDM - View Data

Field values are masked if:

  • Model fields contain masking configurations
  • The request uses JWT authentication
  • You do not have permission to view masked data. You can view masked data if you have the MDM Administrator or MDM Privileged Data Steward role, the MDM - Reveal Masked Data privilege, or the Reveal Masked Data entitlement.
note

You can implement requests for this operation in processes using the HTTP Client connector, as demonstrated by example 1 in the sample process Hub: Get Golden Record Information, which you can install in your account from the process library in Integration.

You can also use Boomi DataHub connector's get golden record operation.

Query parameters

includeReferenceTitle
Record title for the reference record. Boolean. True adds the recordTitle attribute for the reference record in the reference field. The recordTitle attribute shows for the reference fields when the reference value is resolved and the reference universe has the title format defined.

repositoryId
ID of the repository. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.

Path parameters

universeID
ID of the universe

recordID
ID of the golden record

Responses

  • 200 (OK) In the returned entity, the root element name is the universe name. The child elements correspond to the fields in the represented golden record; each element contains the corresponding field value.

    If the returned entity represents an active golden record, the root element’s attributes are as follows:

    • createddate — timestamp of the creation of the golden record.

    • grid — ID of the golden record.

    • updateddate — timestamp of the most recent update of the golden record.

    • source — ID of the source whose entity contribution resulted in the golden record’s creation.

    • recordTitle - record title format (included if configured). If query parameter includeReferenceTitle is set to true and record contains a reference with a title format, record title for the reference is included.

    Sample response body for active golden record:

    <contact createddate="04-23-2012T14:30:26.000-0400" grid="d5742c16-5318-4ba7-8815-3267a7a55358"
     updateddate="02-05-2014T08:44:47.000-0400" source="SF">
       <id>d5742c16-5318-4ba7-8815-3267a7a55358</id>
       <name>bob</name>
       <city>berwyn</city>
       <email>bob@gmail.com</email>
       <bff recordTitle="Douglas Costa">b17a048c-4016-45a1-917a-b9aaa78b2f98</bff>
    </contact>

Field values are masked if model fields contain masking configurations, the user cannot view masked data, and the request uses JWT authentication. Masking is not applied with basic authentication.

If the returned entity represents an end-dated golden record, the root element’s additional attributes are as follows:

  • enddate (in lieu of createddate and updateddate)— timestamp of the end-dating of the golden record.

  • enddatesource — source that requested end-dating of the golden record. A value of *MDM* indicates the end-dating request was a user action within Boomi DataHub.

  • startdate— timestamp of the creation of the end-dated version of the golden record.

  • version — unique ID of the end-dated version.

  • transactionId — transaction ID for the contribution of the end-dated version.

Sample response body for end-dated golden record:

<contact enddate="09-24-2019T15:34:07.000-0400" grid="8219b49a-7806-4cdf-b73e-935d9e3a6bb8" source="SF" 
 enddatesource="SF" startdate="01-07-2016T15:59:05.000-0500" version="723" 
 transactionId="ce62727a-8d80-4fe3-b6de-52a43c3fe856">
   <id>8219b49a-7806-4cdf-b73e-935d9e3a6bb8</id>
   <name>pete</name>
   <city>west chester</city>
   <email>pete@gmail.com</email>
</contact>

  • 400 (Bad Request) The universeID parameter value contains only space characters. Sample response body:

    <error>
      <message>The given universe id is blank.</message>
    </error>

  • 400 (Bad Request) The recordID parameter value contains only space characters. Sample response body:

    <error>
      <message>The given record id is blank.</message>
    </error>

  • 404 (Not Found) universeID does not identify a universe under the authenticated account. Sample response body:

    <error>
      <message>A universe with id 'ac11cc59-c77a-4afe-8c92-ed86a7daabec' does not exist.</message>
      <message>Universe definition with id 'ac11cc59-c77a-4afe-8c92-ed86a7daabec' could not be loaded from plugin component directory 'plugins/mdm/bundles/ac11cc59-c77a-4afe-8c92-ed86a7daabec'.</message>
    </error>

  • 404 (Not Found) recordID does not identify an active or end-dated golden record in the specified universe. Sample response body:

    <errors>
      <error>A record with id '1' does not exist.</error>
    </errors>

  • 401 (Invalid Credentials) JWT auth token is expired. Sample response body:

    <body>
        <h2>HTTP ERROR 401</h2>
        <p>Problem accessing /mdm/universes. Reason:
        <pre>Invalid credentials.</pre></p>
    </body>

  • 403 (You do not have permissions to access this resource) User does not have the required MDM privilege to perform the action. Applicable to JWT auth only. Sample response body:

    <error><message>You do not have permissions to access this resource.</message></error>
On this Page